Strip Common Indentation from BlockString Descriptions #356
Conversation
| @@ -0,0 +1,77 @@ | |||
| package common | |||
There was a problem hiding this comment.
This code is adapted from the graphql-js implementation, which is under the MIT license. This will need attribution as per that license, which I assume is preferred via a comment at the top of the file here?
There was a problem hiding this comment.
@dackroyd, please add a comment at the top of the file that this was translated from the reference implementation and add a link to the original code. I think that this should be enough
There was a problem hiding this comment.
I've added in the MIT License as a header to the file, (copied from https://github.com/graphql/graphql-js/blob/5eb7c4ded7ceb83ac742149cbe0dae07a8af9a30/LICENSE), along with a comment explaining that the implementation here is derived from that reference implementation.
dackroyd
force-pushed
the
strip-common-indentation-from-blockstring-descriptions
branch
from
6cc380c to
698f651
Compare
Multi-line descriptions need to have their common indentation level (which results from indentation of that part of the schema, rather than being intentional for the description text) removed to ensure the descriptions use the correct value, are formatted correctly etc This is to meet the condition documented in the GraphQL spec: https://graphql.github.io/graphql-spec/June2018/#sec-String-Value > Since block strings represent freeform text often used in indented > positions, the string value semantics of a block string excludes > uniform indentation and blank initial and trailing lines via > BlockStringValue().
Fixes #355